RDSC-3972: RDI now supports Google Spanner public docs #2004
Conversation
ZdravkoDonev-redis
requested review from
andy-stark-redis,
Copilot and
yaronp68
|
|
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive documentation for setting up Google Cloud Spanner as a source database for Redis Data Integration (RDI). The documentation covers the complete setup process from database preparation to deployment configuration.
Key changes:
- Creates detailed setup guide for Spanner CDC configuration and authentication
- Adds Spanner to the supported source database versions table
- Provides complete configuration examples for both snapshot and streaming phases
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| content/integrate/redis-data-integration/data-pipelines/prepare-dbs/spanner.md | New comprehensive documentation file covering Spanner setup, service account creation, secrets configuration, and RDI pipeline configuration |
| content/embeds/rdi-supported-source-versions.md | Adds Spanner entry to the supported database versions table |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
content/integrate/redis-data-integration/data-pipelines/prepare-dbs/spanner.md
Outdated
Show resolved
Hide resolved
content/integrate/redis-data-integration/data-pipelines/prepare-dbs/spanner.md
Outdated
Show resolved
Hide resolved
ZdravkoDonev-redis
changed the title
ZdravkoDonev-redis
changed the title
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Hi @ZdravkoDonev-redis. I've made a few in-line suggestions, and also some broader changes for you to consider.
content/integrate/redis-data-integration/data-pipelines/prepare-dbs/spanner.md
Outdated
Show resolved
Hide resolved
content/integrate/redis-data-integration/data-pipelines/prepare-dbs/spanner.md
Outdated
Show resolved
Hide resolved
content/integrate/redis-data-integration/data-pipelines/prepare-dbs/spanner.md
Outdated
Show resolved
Hide resolved
content/integrate/redis-data-integration/data-pipelines/prepare-dbs/spanner.md
Outdated
Show resolved
Hide resolved
| appropriate permissions. This service account will then be provided to RDI as a secret for | ||
| authentication. | ||
|
|
||
| ### Step 1: Create the service account |
There was a problem hiding this comment.
Use a numbered list here instead of "Step 1", "...", which is more consistent with the other docs in related topics. Remember to add four spaces before each line that should be under each step.
|
@ZdravkoDonev-redis: please sign the CLA. |
content/integrate/redis-data-integration/data-pipelines/prepare-dbs/spanner.md
Outdated
Show resolved
Hide resolved
| Spanner is only supported with RDI deployed on Kubernetes/Helm. RDI VM mode does not support Spanner as a source database. | ||
| {{< /note >}} | ||
|
|
||
| You must have the necessary privileges to manage the database schema and create service accounts |
There was a problem hiding this comment.
this is lacking:
The user needs to define a service account with permissions X,Y,Z with which RDI will authenticate to use spanner
| Make sure to replace the relevant connection details with your own for both the Spanner and target | ||
| Redis databases. | ||
|
|
||
| ## 6. Additional Kubernetes configuration |
There was a problem hiding this comment.
this is done during installation IIRC as part of values.yaml
so needs to be added to k8s installation - configure to install when using Spanner as source
There was a problem hiding this comment.
@yaronp68 This is specific to the spanner as we're configuring the flinkCollector. I think here is the correct place?
We could add it to the other doc as well...
There was a problem hiding this comment.
@ZdravkoDonev-redis how would the customer discover this when installing? Maybe add a If you plan to use Spanner with this installation of RDI please have a look at link
@dwdougherty FYI
Co-authored-by: Yaron Parasol <[email protected]> Co-authored-by: David Dougherty <[email protected]>
| Make sure to replace the relevant connection details with your own for both the Spanner and target | ||
| Redis databases. | ||
|
|
||
| ## 6. Additional Kubernetes configuration |
There was a problem hiding this comment.
@ZdravkoDonev-redis how would the customer discover this when installing? Maybe add a If you plan to use Spanner with this installation of RDI please have a look at link
@dwdougherty FYI
Reworking our internal Confluence doc for setting up Spanner as official documentation on how RDI works with Spanner.